Skip to content

docs: distinguish trial, global, and daily review limits in troubleshooting - #16

Open
comlaterra wants to merge 1 commit into
mainfrom
docs/review-limit-429-messages
Open

docs: distinguish trial, global, and daily review limits in troubleshooting#16
comlaterra wants to merge 1 commit into
mainfrom
docs/review-limit-429-messages

Conversation

@comlaterra

Copy link
Copy Markdown
Member

Summary

optibot-be PR #1892 (per-org trial and global review limits) introduced two new 429 reasons on top of the existing daily rate limit. The CLI (PR #28) and MCP (PR #24) render distinct messages for each, but the skill's troubleshooting table still described 429 as only "Daily quota exhausted." This aligns the skill docs with the shipped backend contract.

Changes

  • Split the single Review limit reached (429) troubleshooting row into three, matching the backend's three distinct 429 outcomes:
    • Daily review limit → wait for the reset shown in the error.
    • Trial review limit (TRIAL_REVIEW_LIMIT_REACHED) → upgrade at agents.getoptimal.ai/dashboard/billing.
    • Org review ceiling (MAX_REVIEW_LIMIT_REACHED) → contact getoptimal.ai/contact.
  • Reworded the usage-counter note so it no longer frames the quota as daily-only ("out of the applicable review limit").

Notes

  • Documentation-only change to skills/optibot/SKILL.md; no behavior or manifest changes, no version bump.
  • Reviewed with the Optibot skill (optibot review -b main): Code Looks Good, no blocking findings.

…ooting

The backend now returns three distinct 429 reasons (daily rate limit,
TRIAL_REVIEW_LIMIT_REACHED, MAX_REVIEW_LIMIT_REACHED). Split the single
429 troubleshooting row into three so the fix guidance matches: daily ->
wait for reset, trial -> upgrade, org ceiling -> contact. Also reword the
usage-counter note so it no longer frames the quota as daily-only.

@agent-optibot agent-optibot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary

This PR updates the documentation for the optibot skill, clarifying the different types of review limits a user might encounter. It expands the error handling section to provide more specific guidance for 429 errors related to daily, trial, and organizational usage quotas.

Key Changes

  • The description of the Usage counter has been generalized from "daily limit" to "applicable review limit" to account for different types of quotas.
  • The error message table has been expanded to differentiate between three types of 429 "limit reached" errors:
    • Daily review limit: For individual daily quotas.
    • Trial review limit: For total reviews allowed during a trial.
    • Organizational review limit: For an organization's overall review ceiling.
  • Each new error type now has a specific, actionable "Fix" instruction, guiding the user on how to resolve the issue (e.g., waiting, upgrading, or contacting support).
All Relevant File Changes (click to expand)
  • skills/optibot/SKILL.md
    • Updated the "Usage counter" description to be more general.
    • Replaced the single Review limit reached (429) error entry with three more specific entries for daily, trial, and organizational limits, each with tailored remediation steps.

💬 Feedback & Commands

Share feedback on my comments with 👍 👎 — I'll stop raising issues you push back on. Think I missed something? Adjust my sensitivity →

5 things I can do →
  • #optibot review — I'll re-review your latest changes (incremental)
  • #optibot full review — I'll re-review the entire PR from scratch
  • #optibot fix — I'll apply my suggested fixes to your code
  • #optibot compliance — I'll run a compliance check on your changes
  • #optibot release notes — I'll write up release notes for your production release

💡 Tip: You can configure auto-approvals, summary depth, and when I trigger reviews in Advanced Config.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant